home
***
CD-ROM
|
disk
|
FTP
|
other
***
search
/
Network Support Library
/
RoseWare - Network Support Library.iso
/
logbatch
/
lanbat.exe
/
USERMAN.DOC
< prev
Wrap
Text File
|
1993-08-01
|
47KB
|
1,254 lines
LAN Batch Server 1.2
--
LAN Batch Server(tm)
THE Local Area Network Task Scheduler
The LAN Batch Server(tm) manual and program were written by
Paul Combellick.
COPYRIGHT(c) Paul Combellick, All Rights Reserved, 1993.
The LAN Batch Server(tm) documentation and software contain
copyrighted works and may only be reproduced or duplicated
under the terms of the user license agreement.
TRADEMARKS:
Dbase III+ is a trademark of Ashton-Tate, Inc.
Lotus 1-2-3 is a trademark of Lotus Development Corp.
MS-DOS is a trademark of Microsoft Corporation.
IBM AT is a trademark of IBM Corporation.
Clipper is a trademark of Nantucket Corporation.
Novell Netware is a trademark of Novell, Inc.
3+Share is a trademark of 3COM Inc.
Dr. Switch is a trademark of Black and White International.
Pkzip, Pkunzip are trademarks of PKWare, Inc.
CompuServe is a trademark of CompuServe, Inc.
LAN Batch Server(tm) is the type of productivity enhancing
software that you have come to expect from the Computer
Catalyst. This powerful utility program keeps your
computers working even when you're not. LAN Batch Server(tm)
will schedule time consuming computer tasks to run during
non-prime time business hours. All this power, plus it is
easy to setup and can be accessible by every Macintosh or PC
user on your network.
TABLE OF CONTENTS
SYSTEM REQUIREMENTS
PACKING LIST
BENEFITS FOR REGISTERING
TECHNICAL SUPPORT
PREPARATION BEFORE CALLING
INSTALLATION
QUICK START
WHAT IS LAN BATCH Server(tm)?
HOW DOES IT WORK?
FEATURES
SETTING UP TASKS IN THE QUEUE
USING BSC.exe -
USING .JOB FILES
CHECKING THE STATUS OF TASKS
EXECUTING TASKS IN THE QUEUE
USING BS.EXE
SEMAPHORE FILES
BONUS FEATURES
BATCH.EXE,CLIPPER API
PARTIAL LISTING OF
CLIPPER API
SAMPLE TASKS
USING BSC.EXE
USING CLIPPER API
USING .JOB FILES
USING BATCH.EXE
TROUBLE SHOOTING GUIDE
GLOSSARY
LICENSE AGREEMENT
WARRANTY
SYSTEM REQUIREMENTS
IBM PC or Compatible, including Laptops.
MS-DOS 3.3 or greater.
5.25 inch floppy drive.
Hard Disk Required. Approximately 1.0 MB disk space
required.
LAN Optional. (Network which can run Clipper applications.)
Such as Novell Netware or MS-NetBios Networks.
NOTE: This release is NOT network specific.
PACKING LIST
Your LAN Batch Server(tm) software package includes the
following:
Disk #1:
* Users Manual (UserMan.doc)
* LAN Batch Server(tm) User Interface
( BSC.exe)
* LAN Batch Server(tm) Engine ( BS.exe).
* Bsque.dbf ( queue database file ).
* Help files ( Bshelp.dbf , bshelp.dbt ).
* Queue Report ( Bs.frm ).
Bonus Disk for registered users only, (not for shareware
distribution):
* LAN Batch Server(tm) command line
queue interface (BATCH.exe).
* Clipper API source & example files
(bs_api.prg)
* CodeBase API source & example files
BENEFITS OF REGISTERING YOUR SOFTWARE
Registration Fee is $95.00 per file server or shared disk
that the queue file, bsque.dbf, is loaded on.
Free updates and technical support for one year.
Receive source code to access the LAN Batch Server(tm) queue
file from a Clipper 5.x and Summer '87 applications.
Receive source code to access the LAN Batch Server(tm) queue
file from a C application using CodeBase.
Receive BATCH.exe, which provides command line access to the
batch queue.
Telephone support: (602) 946-9341.
Electronic mail support via CompuServe:. Paul Combellick:
70671,3054
NOTE: This release is NOT network specific.
HOW TO REGISTER (See REGIST.TXT on this disk.)
TECHNICAL SUPPORT
Technical support is provided, for registered users only, by
Computer Catalyst Corporation at the following address:
Computer Catalyst Corporation.
P. O. Box 14576
Scottsdale, AZ 85267-4576
(602) 946-9341 Voice and FAX
Compuserve ID#: 70671,3054, Paul Combellick
Computer Catalyst encourages both positive and negative
feedback from LAN Batch Server(tm) users. If you are having
technical problems with LAN Batch Server(tm), have ideas for
enhancements, or have a unique or interesting way of using
LAN Batch Server(tm), please send us a letter, fax, email, or
give us a call!
SOFTWARE MAINTENANCE AGREEMENT
Includes 1 year software upgrades. Annual support fee
covers technical support and software upgrades and
enhancements for one year.
PREPARATION BEFORE CALLING FOR SUPPORT
Having complete and pertinent information about the
questions or problems you are having can reduce delays and
expedite answers. Please provide the following information:
1 Registered Users Name and
Address
2 LAN Batch Server(tm) Serial
Number and Version number
3 DOS brand and version
4 Copy of CONFIG.SYS
5 Copy of autoexec.bat
6 Amount of RAM available
before loading
7 Amount of disk space available
8 Copies of BS.LOG and BS.ERR
9 Description of problem in
complete detail.
10 Other symptoms
INSTALLATION
LAN Batch Server(tm) should be installed on a hard drive. The
queue file, BSQUE.DBF should be installed on a shared
network. The exe files may be stored locally or on the file
server.
The installation of LAN Batch Server(tm) on your hard disk will
be handled by the INSTALL.BAT batch file included on your
program disk. About 1.0 megabytes of space are required on
the target disk.
After installation, you should define two DOS environment
variables BS and BS_DATE. BS should contain the path to the
directory that contains the queue file, BSQUE.DBF. The
default is the current directory. BS_DATE should contain
your preferred date format. The default is AMERICAN. Other
date format options are ANSI, BRITISH, FRENCH, GERMAN, or
ITALIAN.
For example, add the following two lines to your
autoexec.bat:
SET BS=Z:\BS
SET BS_DATE=ANSI
This sets the queue directory to Z:\BS and the date format
to ANSI.
This installation procedure will: MAKE a directory on drive
C: named C:\BS COPY all the necessary files from the program
disk INSTALL LAN Batch Server(tm) with the following steps
Change to drive A:
Type A: <ENTER>
Place program disk in drive A, Type INSTALL <ENTER>
The install program will copy all necessary files to run LAN
Batch Server(tm) to C:\BS. The INSTALL program will verify that
all files are successfully copied, if an error is detected,
you will be prompted to try again.
To have the install program copy the files to a different
destination, type in that destination after the INSTALL
command and before pressing <ENTER>.
EXAMPLE: INSTALL D:\BS <ENTER>
This will create a directory on drive D: called \BS and copy
the files into it.
QUICK START
Use your networked computers 24 hours a day. LAN Batch
Server(tm) is designed to schedule jobs to run during free time
on a MS-DOS system. First, set up the tasks to run.
Schedulable tasks are batch files, executable programs, any
task that can be run from the DOS prompt. These tasks can be
scheduled to execute on any schedule; once, hourly, daily,
monthly, yearly, or beginning on a certain day at a
specified time with a specified ending date and time. These
tasks can be added to the queue even while the engine, or
back end is running.
Next, start the engine of LAN Batch Server(tm) on a local or
remote PC on the LAN. The LAN Batch Server(tm) engine steps
through the queue of tasks, prioritizes, and spawns tasks,
until it is turned off.
To RUN LAN Batch Server(tm):
Change drive to D:
type D: <ENTER>
Change to BS directory type
CD\BS <ENTER>
To add items to the queue type BSC
<ENTER>
Select ADD, edit the fields, select <F10> to save and exit
the edit mode.
To start the engine program type
BS <ENTER>
What is LAN Batch Server(tm)?
Computer Catalyst Corporation is proud to announce the
release of LAN Batch Server(tm). The Local Area Network Task
Scheduler. LAN Batch Server(tm) allows you to maximize the use
of your expensive computer resources. With LAN Batch Server(tm)
you no longer have to be around to tell you computer what to
do, just tell LAN Batch Server(tm) what you want done, when you
want it done and LAN Batch Server(tm) will do the rest - it
works 24 hours a day, so you can enjoy your time off.
Most computer resources are utilized during the normal
business hours of the day, typically 8-5. this is only 8
hours out of a 24 hour day, this means that for two-thirds
of the time these valuable tools sit idle.
LAN Batch Server(tm) helps you maximize your computer resources
by allowing you to schedule time intensive tasks to run
during non-critical hours, instead of prime time when most
computer resources are often being used to their capacity.
LAN Batch Server(tm) is an application program that will allow
users connected to a local area network to schedule tasks to
execute at any time of the day or night. Any application,
Macintosh, or PC that can write an ASCII file to a network
queue directory, can add tasks to the queue.
With LAN Batch Server(tm) you can schedule reports to be
processed and printed at night so they are ready at the
beginning of the next work day.
Programmers can schedule time consuming compiles and links
to run after they have gone home for the day.
Critical functions like complete BACKUPS can be scheduled to
run at anytime of the day or night.
Database maintenance such as REINDEXING & PACKING can easily
be performed during non business hours.
How does LAN Batch Server(tm) work?
LAN Batch Server(tm) is a client/server application program.
The clients schedule tasks for the servers to execute.
These tasks or jobs may be scheduled to run only once or at
set intervals such as hourly, daily, weekly, or monthly.
LAN Batch Server(tm) gives the user complete flexibility on the
frequency to schedule jobs for execution. One or more
computers can be designated as batch servers. The servers
execute the jobs sent by the clients on the network. Any
users on the network can be a client and schedule tasks for
the server to execute. The server puts each task in its TO
DO list called a QUEUE. There are four different ways to
access the queue:
BSC.exe: The front end queue editor or
client allows the user to add, edit, delete, and
monitor tasks in the queue file named BSQUE.DBF.
BATCH.exe: This command line program allows users
to add tasks to the queue directly from the DOS
command line or from a DOS batch file.
.job files: User created ASCII files containing
queue entries.
API: Provides Clipper or C programmers a method to
access the queue directly from their own software.
The back end batch executive or server engine, BS.EXE,
monitors the queue file for tasks that are scheduled for
execution. When the tasks' schedule time arrives the server
spawns the task and allows it to run to completion.
FEATURES
Create a report server or compile server.
Schedule network monitor utilities to run periodically.
Semaphore files allow the LAN manager to control access to
the queue.
MAC users on the network can add tasks to the queue with an
ASCII file.
Any number of PCs can submit jobs. Any number of PCs can
execute jobs.
Jobs can be submitted to the queue while the engine is running.
Don't tie up your valuable PC time with that big accounting
or database report.
For registered users only, API source code for Clipper and
Codebase programs to access the queue.
Split a job into pieces and send it to multiple machines.
Indexing, reporting, packing, calculating, backing up the
system, can be run while no one is around. No idle waiting
time, just the computer(s) running non-interactive tasks.
Eliminate personnel downtime while waiting for a report to
be generated. LAN Batch Server(tm) can assign a report to a PC
which is currently unoccupied or unused. Perhaps a worker
is out sick and their computer is idle or you have an old
machine that no one uses because it is too slow, now these
PCs can be put to work, while your machine is free for you
to continue your work.
Schedule batch files to run after midnight that compile and
link, reindex, pack or back up your system. Create batch
files for jobs that don't need interactive input and
schedule them in the LAN Batch Server(tm).
Use a keyboard buffer stuffer for interactive tasks.
CAVEAT: IT IS POSSIBLE TO USE THIS TOOL TO CIRCUMVENT
NETWORK SECURITY. HAVE THE LAN BATCH Server(tm) ENGINE (BS.EXE)
RUN ON A WORKSTATION WHOSE NETWORK LOGIN HAS NO HIGHER
ACCESS RIGHTS THAN THE USER THAT SCHEDULED THE JOB.
SETTING UP TASKS IN THE LAN BATCH Server(tm) QUEUE
USER ID:
Before you use LAN Batch Server(tm) you may first specify your
name or Network User ID. This will be useful in checking
the status of in-progress jobs. LAN Batch Server(tm) has a
report option which will print out a progress report on the
jobs in the queue. This report can be sorted on USERID.
The USERID may be specified in a DOS environment variable.
SET USER=<your name here>
There are four methods to add tasks to the queue:
(1) BSC.exe,
(2) BATCH.exe
(3) .JOB files
(4) the API
Using BSC.exe
BSC.exe is the client program to add, edit, delete and
monitor tasks in the queue file. Type BSC <ENTER> at the
C:\BS prompt or at the LAN Batch Server(tm) directory you
specified. All fields are optional except for the command
line. To add to the queue, select ADD, edit the fields,
select <F10> to save and exit the edit mode.
THE SCREEN
The queue editor input screen is separated into several
areas. Along the bottom are the menu selections which are
your choices in manipulating the queue. At the top of the
screen is the heading with some information such as version
number and in the upper right hand corner, the current
record number. The two areas in the center are Schedule
Information, which is user modifiable, and Status
Information, which is program modifiable. Schedule
Information is where the items are added into the queue.
Status Information is where the engine writes the progress
being made in the queue.
On line help is available by pressing F1.
MENU SELECTIONS
These menu choices appear at the bottom of the screen.
ADD Add a new entry into the Queue.
BROWSE View the Queue in table form.
CLONE Copy the displayed entry to
another record.
DEL Remove a job from the Queue
and delete the record.
EDIT Modify the displayed Queue
entry.
FIND Find an entry in the Queue based
on the current Sort.
INDEX Remove blank queue entries and
rebuild the index files.
LOG View the Queue status log file. Contains a
history of tasks that have been executed. Records
start/stop of server engine. Reports which server runs a
task, begin / end time, and execution status. (BS.LOG will
become full and you may wish to delete it when it becomes to
lengthy.)
NEXT Advance to the next entry
depending on current Sort.
PREV Move to the previous entry
depending on current Sort.
QUIT Return to DOS.
REPORT Generates a report based on
current sort criteria.
SORT Select the display Sort criteria
(there are a total of 4):
*Primary sort: schedule date +
time.
*by command line entry.
*by userid + schedule date
+ time.
*by record number.
Sort does not change the actual
order of jobs in the queue, only
the display order.
COMMAND LINE:
This is the only mandatory field. It CANNOT be left blank.
If all other fields are left blank, this item will be run as
soon as possible when the server engine is running.
This is the command that you want the LAN Batch Server(tm) to
have DOS execute. This string can be 125 characters long (it
will scroll off the screen), and should contain the name of
an executable file or a batch file. It cannot contain
interactive commands.
EXAMPLE:
1) DIR > DIR.TXT
This would write the current directory
listing into a file called DIR.TXT.
2) DBASE SAMPLE
This would run the dBASE program
sample.prg provided that dBASE.exe
is in the path.
3) SAMPLE
This would run this SAMPLE.COM,
SAMPLE.EXE, OR SAMPLE.BAT if it
is on this directory or in the path.
4) CMAIL /A REPORT.TXT /T NAME
This would send a 3COM electronic
mail to NAME.
You can create batch files for situations that don't require
interactive commands.. When writing batch files be sure to
restore the current drive and current directory to the LAN
Batch Server(tm) directory at the end of the batch file.
Example batch files that can be executed from LAN Batch
Server(tm).
CUSTLIST.BAT
F:
cd\cust
dbase custlist
C:
cd\bs
*CUSTLIST.PRG
use custlist
INDEX ON name TO NAME
quit
See Setting Up Sample Tasks.
BEGIN DATE
This field is optional and its default is blank. If left
blank the job will execute as soon as possible. The range
is today until the end date or forever.
This date field determines when the entry will be executed.
The LAN Batch Server(tm) will execute this entry when the DATE
+ TIME is passed. The execution time is not guaranteed;
however, entries are processed in DATE + (TIME * PRIORITY)
order. If a task's scheduled begin time is passed, it will
be executed as soon as a server is available. Tasks are
ALWAYS executed in DATE + (TIME * PRIORITY) order.
Several DATE types are supported:
AMERICAN mm/dd/yy (DEFAULT
FORMAT)
ANSI yy.mm.dd
BRITISH dd/mm/yy
FRENCH dd/mm/yy
GERMAN dd.mm.yy
ITALIAN dd-mm-yy
In order to specify a non-AMERICAN date format, define DOS
environment variable "BS_DATE" to the format of the date
desired. Now, re-index the index files in the program
directory by selecting I for index in BSC.exe.
EXAMPLE: To define ANSI date format, type:
SET BS_DATE=ANSI
At the DOS prompt. The date display format will now be
ANSI.
BEGIN TIME
This field is optional and the default is blank. If left
blank, it will be run as soon as possible.
Specify the scheduled TIME to execute the job. Remember,
jobs are processed as soon as possible ON or AFTER the
scheduled execution time. No job is interrupted to execute
another. Each job is allowed to complete before the next
task is spawned.
The LAN Batch Server(tm) clock is a 24 hour clock, therefore if
you want something to begin at 6:00 p.m., input the time as
18:00 hours.
The time format is: hh:mm:ss (hours, minutes, and
seconds).
The time may be left blank. If the date and time are both
left blank, a job will be executed as soon as possible.
SERVER NAME:
DEFAULT is blank.
Enter the server's "name" or network interface card address.
This can be used to dispatch a job to a SPECIFIC
PC-workstation. Ethernet Network Interface Cards (NIC) have
unique 16 character serial numbers.
***Note, the workstation's NIC address is displayed on line
2 under the program title.
A "name" can also be specified, here. Then, when BS.exe is
executed, a parameter will specify that particular
workstation's "name". Refer to use of BS.exe under "Using
the back end to perform tasks in the queue".
How would one schedule workstation 12 to run report 4?
In the SERVER field, enter 12.
On the workstation that you want to
name as server 12, start the Batch
Server engine with the following
command:
BS /NAME=12
PRIORITY:
DEFAULT is 5.
RANGE is 0, lowest priority, through 9,
highest priority.
OPTIONAL.
The priority enables users to prioritize jobs that are
scheduled for the same date and time. Remember, scheduled
execution time is not guaranteed, jobs run based on DATE + (
TIME * PRIORITY ).
FREQUENCY:
OPTIONAL.
DEFAULT is 1 time execution.
RANGE: 1 time, minutes, hourly, daily,
weekly, monthly.
Note: The frequency cannot be more often then the
delay time the queue is searched for pending tasks. This
delay time is specified when the server engine is started.
(See "Using the back end to perform tasks in the queue".
If the batch server's delay time, default to one
minute, is set at 15 minutes, then scheduling a task to run
every five minutes will not work as expected.
Mxx Where xx represents the number of MINUTES to wait
before the next execution of this job.
M10 means schedule this job to run again in 10 minutes.
Hxx Where xx represents the number of HOURS to wait before
the next execution of this job.
Dxx Where xx represents the number of DAYS to wait before
the next execution of this job.
D Means schedule it again to run the next day.
Wxx Where xx represents the number of WEEKS to wait before
the next execution of this job.
MOx where x represents the number of MONTHS to wait before
the next execution. of this job.
Note: the "xx" number is optional.
OS: (Operating System.)
OPTIONAL.
DEFAULT is DOS.
RANGE: only DOS.
Currently only DOS is supported in this release. Interested
in other operating systems, such as MS-Windows, Window NT,
or OS/2? Let us know.
END DATE:
OPTIONAL.
DEFAULT is BLANK.
RANGE any future date.
For jobs that are scheduled repetitively, an ending date may
be useful.
END TIME:
OPTIONAL.
DEFAULT is BLANK.
For jobs scheduled repetitively, an ending time may be
useful. The LAN Batch Server(tm) clock is a 24 hour clock,
therefore if you want something to end at 6:00 p.m., input
the time as 18:00 hours.
USING .JOB FILES TO ADD TASKS TO THE QUEUE
Using .JOB files to add tasks to the queue, is a method that
can be used by any program that can write ASCII files. If
the user creates an ASCII file with the .job extension and
copies it to the queue directory, which is pointed to by the
DOS environment variable BS, the LAN Batch Server(tm) Batch
Executive, BS.exe, will read the .job files into the queue
file. This technique provides another method to add tasks
to the queue. The ASCII .job file format is one task per
record, or line, and only the command line is necessary.
For example, create an ASCII file with the .job extension
and the following entries:
REPORT1
REPORT2
A .job ASCII file may be created by any software that can
write to an ASCII file. This means that any computer that
can access the queue directory on the file server, can add
tasks to the queue. This includes non-DOS computers such as
an Apple Macintosh.
STATUS INFORMATION
This information appears on the bottom half of the screen in
BSC.exe and is written by the engine portion of LAN Batch
Server(tm). It allows the user to check the status of tasks in
the queue.
STATUS:
This tells that this item is being processed. Status is
blank if task is pending, I if task is in progress, that is
currently executing, and E if there was an error during
execution of the task.
ERRORLEVEL:
Displays a number representing the results of the
application or DOS command.
Exx: Where xx is the number of the error returned.
The meaning of the number depends on the program or software
running when the error message was given. Different
software packages have different numbers representing
different errors. Check your software specific manual to
determine the problem.
Once the problem is corrected, the item must be resubmitted
to the queue. You can copy the item by cloning it and then
delete the original.
USER NETWORK ADDRESS:
Contains the Network Interface Card Address if readable by
application.
SERVER NETWORK ADDRESS:
Will contain the Network interface card address or server
name of the machine that is executing that particular task.
USER ID:
This will be useful in checking the status of in-progress
jobs. Before you use LAN Batch Server(tm) you may first specify
your name or Network User ID. LAN Batch Server(tm) has a
report option which will print out a progress report on the
jobs in the queue. This report can be sorted on USER ID.
The USERID may be specified in a DOS environment variable.
SET USER=<your name here>
If the DOS environment variable USER is not set you can
enter USERID manually.
USING THE SERVER BACK END TO EXECUTE THE TASKS IN THE QUEUE
TYPE BS /(ANY OPTIONS DESIRED) <ENTER> at the DOS prompt in
the directory where BS.EXE is located.
For Example:
BS.EXE /begin=22:00 /until=6:00 /delay=15 /name=PC12
This means begin processing the queue at 10:00 p.m. Quit at
6:00 a.m. Set the delay between loops through the queue at
15 minutes. The server name is PC12.
Type BS.EXE ? <ENTER> at the DOS prompt to get all possible
arguments. These options will appear:
/until=<time> Process UNTIL a planned Time.
/begin=<time> Begin Processing at Time.
/loops=<number> Process each item a given NUMBER of times.
/delay=<minutes> Set DELAY between Processing Loops.
/name=<string> Set NAME of this server. This is how to
assign jobs to a server by it's NAME.
These commands may be abbreviated by using the first two
characters in the command word.
ADMIN FUNCTIONS: SEMAPHORE FILES
These semaphores were developed as a result of several years
of network administrator experience on the part of the
author. Semaphore files, or signals, are specially named
files that BSC.exe, BATCH.exe, and BS.exe look for in the
queue directory, pointed to by the DOS environment variable
BS. The presence of these files signal certain actions by
the LAN Batch Server(tm) programs. The contents of these files
are meaningless and may be empty. The purpose of these
semaphores, is to allow the Network Manager to control
access to the queue by creating a file with a text editor or
batch file.
The SERVER software, BS.exe, responds to the following
semaphores:
LOGOUT.BS - Causes server software (BS.exe) to exit to DOS.
REBOOT.BS - Run REBOOT.COM at the DOS prompt.
REINDEX.BS - reindex queue file.
PAUSE.BS - Causes wait until semaphore (PAUSE.BS) is
deleted.
The CLIENT software, BSC.exe or BATCH.exe,responds to the
following semaphores:
LOGOUT.BSC - Causes exit to DOS.
PAUSE.BSC - Causes wait until semaphore (PAUSE.BSC) is deleted
For example, if the Network Manager wants all users that are
running BSC.exe, to exit to DOS, create a file named
LOGOUT.BSC in the queue directory. When BSC.exe or
BATCH.exe detect the presence of the file LOGOUT.BSC, the
software will exit to DOS.
The PAUSE semaphore, causes the software to close the queue
file, BSQUE.DBF, and wait a minute. After a one minute
wait, it checks for the presence of the PAUSE semaphore and
if found, repeats the one minute wait.
The server software, can be forced to REBOOT with the
REBOOT.BS semaphore. This works only if there is a program
named REBOOT in the path. This utility is not supplied with
the LAN Batch Server(tm) software and is available as shareware
or a utility elsewhere.
The last semaphore is REINDEX.BS. This signals the server
software, BS.exe, to delete the queue's index files and
recreate them. This will not succeed if other user's have
the queue file open. This is why it is important for user
written programs to close the queue file when not actually
accessing the queue.
User written programs should respond to the same signals as
LAN Batch Server(tm) client programs. This will maintain a
consistent response by all users of the queue file and will
allow the Network Manager to perform maintenance tasks upon
the queue and the program files.
BONUS FEATURES FOR REGISTERED USERS ONLY:
(These are not included on the shareware disk)
BATCH.EXE: COMMAND LINE QUEUE ACCESS.
In addition to the BSC.exe queue editor, users may add tasks
to the queue simply by preceding the desired command with
the command: BATCH. For example, to add a task to the queue
named "REPORT1" type:
BATCH REPORT1
This will add a record to the queue file with "REPORT1" as
the command line.
CLIPPER API: The Clipper Application Programmer's Interface
provides source code that users of Clipper Summer '87 or
Clipper 5.x can use to access the LAN Batch Server(tm) queue
file, bsque.dbf. See sample tasks.
CODEBASE API: The CodeBase Application Programmer's
Interface provides source code that users of CodeBase can
use to access the LAN Batch Server(tm) queue file, bsque.dbf.
CLIPPER API
Partial Listing of BS_API.PRG - the Clipper API to LAN Batch
Server(tm) queue file: (This is available for registered users
only. See Benefits of registering.)
SETTING UP SAMPLE TASKS
Using BSC.exe
Start the front end by typing BSC at the LAN Batch Server(tm)
Directory.
Input your USERID which can be your name.
Type A to ADD a record.
Type DIR > TEST1.TXT at command line.
Press F10 to save this record and then Q to QUIT.
From your PC or another workstation on the network: Type BS
at the DOS prompt to run the server engine.
The server engine or back end then runs and deletes the
queue item. Press escape to stop the engine from running.
Type BSC at the DOS prompt and see that the queue is empty.
Look at the log. Type L for LOG and notice that it ran.
Type A to ADD a job to the queue.
Type Dir. > test2.txt put in 2 minutes from your current
system time. Save and quit. Start the engine by typing BS.
Let a couple minutes pass. Type BSC and see the queue is
empty and look at the log and when the item was processed.
Type A to ADD a job to the queue.
Type Dir > test3.txt. Put in 2 minutes from your current
system time and then put into the frequency field D which
means daily. Quit and run the Engine. Allow the server,
BS.EXE, to run through the queue for at least two minutes
then go back to view the queue with BSC.EXE. See that the
entry is still there and that the date field has been
updated to tomorrow's date. It will run each day until this
item is deleted from the queue.
USING THE API TO ACCESS THE QUEUE (For Registered Users)
Suppose you have written a Clipper application that has two
main components. The first is the user interface or editor,
called EDIT.exe, and the second is the report module, called
REPORT.exe or you might use the R&R Report Writer. The
editor could be designed to allow the user to view and edit
records in your database. Since your database is several
megabytes in size and contains thousands of records, no user
wants to tie up their PC while reports or queries are
generated. The way around this would be to add a query
builder module to the editor to allow the user to define
queries or reports. After the user has defined a report,
the editor would write an entry into the LAN Batch Server(tm)
queue file, BSQUE.DBF, using the Clipper API (see
BS_API.PRG). One or more other PCs on your network may run
the LAN Batch Server(tm) engine, BS.exe and actually execute
the report module of your application. This means that
while the report is running on the server PC, the user's PC
is not tied up. You may also schedule the report to run at
night. If you create a batch file that contains several
commands such as print the report to a file, then email the
report to a list of people, then notify the sender that the
report is complete. The batch file might look like this:
rem MYREP.BAT
rem example batch file for reporting
rem
REPORT <arg1> <arg2>
EMAIL <arg3> <arg4>
SEND "your report sent!" TO <user>
Using .JOB files to access the queue
If your database or programming language does not support
the Clipper API, such as C or Basic, or another dBase
compatible, the only change in this technique is that
instead of writing directly to the queue, you would write
your queue request into a .job file and write the file into
the same directory that contains the active queue file. The
server software, BS.exe, will read the .job file and load it
into the queue file.
Using BATCH.exe (For Registered Users)
To add a task to the queue named "REPORT1" type:
BATCH REPORT1
This will add a record to the queue file with "REPORT1" as
the command line.
TROUBLESHOOTING
Symptom: Bad command or file name when trying to run BSC.exe
or BS.exe
Problem: BSC.exe or BS.exe not in path
Resolution: Consult DOS manual to configure path.
Related Problem: Similar path problems can occur when BS is
processing the queue. If your program or batch file changes
the current directory it should restore the current
directory to whatever it was before your program ran.
Symptom: Cannot view BS.LOG file from BSC
Problem: BS.LOG does not exist or is larger than 64 K.
Resolution: BSC.exe is a Clipper application and cannot view
a text file larger than 64K. You can rename or delete your
current BS.LOG file and BS.exe will create a new file when
it is run.
Related Problem: If you have limited hard disk space,
BS.LOG should be periodically reviewed and deleted.
Symptom: Cannot find record in queue or, applications kicks
you out when moving between records.
Problem: Corrupted index file
Resolution: Select Index in BSC.exe to recreate the index
file
GLOSSARY
API Application Programming Interface.
Method to access the queue file from a user written program.
Supported languages are Clipper Summer '87 & 5.x and C.
BACK END Server program that actually runs the tasks
placed in the queue by the client program. See server & BS.exe.
BATCH.EXE Command line utility to add tasks to the queue file.
BS DOS environment variable that contains a
path to the queue file.
BS_DATE DOS environment variable that defines the
DATE format. May be AMERICAN, ANSI, BRITISH, FRENCH,
GERMAN or ITALIAN.
BS.EXE Server program that actually runs the tasks
placed in the queue by the client program. See server & back end.
BSC.EXE Client program used to add, edit, or delete tasks in
the queue file. This program is also used to monitor the status of
tasks in the queue.
CLIENT Program that users use to edit the queue file.
See also BSC.exe, .job, and BATCH.exe.
DATE TYPE see bs_date
ERROR FILE ASCII file, bs.err, that the programs write error
messages into. This is a good place to look for clues as to why
a program failed to work as expected.
FRONT END see client, bsc.exe, and batch.exe
INDEX FILE A file with a .ntx extension that contains the
"sort order" of the database file. These sometimes get corrupted.
See the trouble shooting guide.
.JOB FILE An ASCII file that the user created and specified a
task for LAN Batch Server(tm) to run. This provides a method for
many Mac or PC applications to add tasks to the queue.
Write this file into the queue directory.
LOG FILE An ASCII file that contains historical information
about the execution of tasks in the queue. It records when servers
were started or stopped and when tasks were executed. BS.LOG.
PATH TO QUEUE See queue directory.
QUEUE A dbase III+ .dbf file named bsque.dbf, that contains
the list of tasks and their schedule information.
QUEUE DIRECTORY Directory that contains the queue file, queue index
files, help file (bshelp.dbf & bshelp.dbt & bshelp.ntx). This directory
may be the "current" directory or the directory pointed to by the DOS
environment variable BS. See BS.
QUEUE FILE See queue.
SEMAPHORE An empty file whose existence in the queue directory
signals the client and server portions of LAN Batch Server(tm) to
take an action. The semaphores are LOGOUT, PAUSE, REBOOT, REINDEX.
See the section on Semaphores.
SERVER In the context of LAN Batch Server(tm), the server
software is BS.exe and a server is any computer that runs the server
software. Don't confuse this with FILE SERVER! Although the software
and queue file may exist on the file server's hard disk, none of
the programs that are part of LAN Batch Server(tm) are executed
by the file server. This is a very subtle but important point.
LICENSE AGREEMENT
Copyright (c) 1991 by COMPUTER CATALYST CORPORATION all rights
reserved.
Read carefully the following terms and conditions. Use of
this product (LAN Batch Server(tm)) constitutes your acceptance
of these terms and conditions and your agreement to abide by
them.
This is a legal agreement between you, the end user, the
licensee and COMPUTER CATALYST CORPORATION, licensor. By
using this package, you are agreeing to be bound by the
terms of this Agreement. If you do not agree to the terms of
this Agreement and you purchased this package directly from
COMPUTER CATALYST CORPORATION, promptly return the disk
package and accompanying items (including written materials
and binders or other containers within thirty (30) days to
COMPUTER CATALYST CORPORATION for a refund, less the
shipping and handling charges. If you obtained the software
through a reseller, dealer or distributor consult them for
their return policy.
You, the original purchaser, are granted a non-exclusive
license to use this software under the terms stated in this
Agreement. YOU MAY NOT LOAD THE SOFTWARE OR QUEUE FILE ON
MORE THAN ONE NETWORK FILE SERVER OR SHARED DISK AT THE SAME
TIME. HOWEVER, YOU MAY LOAD THE EXECUTABLE FILES ON AN
UNLIMITED NUMBER OF LOCAL HARD DRIVES THAT ARE NOT SHARED BY
OTHER USERS. You may not rent or lease the Software, but you
may transfer it on a permanent basis if the person receiving
it agrees to the terms of the Agreement. If the Software is
an update, any transfer must include the update and all
prior versions.
You may NOT loan, rent, lease or transfer them to another
user except as part of the permanent transfer (as provided
above) of all the Software and accompanying items.
LICENSEE ACCEPTS PROGRAM "AS IS", "WITH ALL FAULTS", AND IN
LIEU OF ALL OTHER WARRANTIES AND CONDITIONS, EXPRESSED OR
IMPLIED, INCLUDING, BUT NOT LIMITED TO, THOSE FOR
MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE.
LICENSOR AND/OR DISTRIBUTOR ACCEPTS NO RESPONSIBILITY FOR
THE OPERATION OR PERFORMANCE OF THE PROGRAM. THE ENTIRE RISK
OF USE AND CONSEQUENCES OF USE OF THE PROGRAM FALLS
COMPLETELY ON THE LICENSEE. LICENSOR SHALL NOT BE LIABLE IN
ANY RESPECT FOR ANY CLAIMS, LOSS OR INJURY ALLEGED TO HAVE
RESULTED FROM USE OF OR IN RELIANCE ON PROGRAM. IN THIS
RESPECT, LICENSEE SHALL COMPLETELY INDEMNIFY AND DEFEND
AGAINST ANY AND ALL CLAIMS, INCLUDING CLAIMS BY THIRD
PARTIES OR EMPLOYEES OF LICENSEE, WHICH ARISE DIRECTLY OR
INDIRECTLY OUT OF LICENSEE'S USE OR OPERATION OF PROGRAM.
LICENSOR SHALL NOT BE LIABLE FOR ANY INCIDENTAL OR
CONSEQUENTIAL DAMAGES SUFFERED BY LICENSEE THROUGH THE USE
OF PROGRAM, WHETHER OR NOT SUCH DAMAGES SUFFERED BY LICENSEE
THROUGH THE USE OF PROGRAM, WHETHER OR NOT SUCH DAMAGES WERE
DISCLOSED TO, OR REASONABLY FORESEEN.
This Program, User's Manual and reference materials are sold
AS IS, without warranty as to their performance,
merchantability or fitness for any particular purpose. The
entire risk as to the results and performance of this
program is assumed by you.
However, to the original purchaser only, the COMPUTER
CATALYST CORPORATION warrants the magnetic diskette on which
the program is recorded to be free from defects in materials
and faulty workmanship under normal use for a period of
ninety days from the date of purchase. If during this
ninety-day period the diskette should become defective, it
may be returned to COMPUTER CATALYST CORPORATION for a
replacement without charge, provided you have previously
sent in your registration documentation.
Your sole and exclusive remedy in the event of a defect is
expressly limited to replacement of the diskette as provided
above. If failure of a diskette has resulted from accident
or abuse the distributor shall have no responsibility to
replace the diskette under the terms of this limited
warranty.
COMPUTER CATALYST CORPORATION will not be liable for any
special, incidental, consequential, indirect or similar
damages due to the loss of data, loss of business profits,
business interruption or any other reason , even if COMPUTER
CATALYST CORPORATION or an agent of COMPUTER CATALYST
CORPORATION has been advised of the possibility of such
damages. IN NO EVENT SHALL COMPUTER CATALYST CORPORATION'S
LIABILITY FOR ANY DAMAGES EVER EXCEED THE PRICE PAID FOR THE
LICENSE TO USE THE SOFTWARE, REGARDLESS OF THE FORM OF THE
CLAIM.
This Agreement shall be construed and enforced in accordance
with the laws of the State of Arizona. Any action or
proceeding brought by either party against the other arising
out of or related to the Agreement shall be brought only in
a State or Federal Court of competent jurisdiction located
in Maricopa County, Arizona. The parties hereby agree to in
personam jurisdiction of said courts.
If any provision of this Agreement is found void, invalid or
unenforceable, it will not affect the validity of the
balance of this Agreement, which shall remain valid and
enforceable according to its terms.
Licensee acknowledges that it has read the foregoing
disclaimers of warranty and limitation of liability and
understands that Licensee assumes the entire risk of use of
the Program.
This Agreement can only be modified by mutual consent of
both parties.
Should you have any questions concerning this Agreement,
contact COMPUTER CATALYST CORPORATION, Customer Service, P.O.
Box 14576, Scottsdale, AZ 85267-4576. (602) 946-9341.
LIMITED WARRANTY
This Program, User's manual, and reference materials are
sold "As is," without warranty as to their performance,
merchantability, or fitness for any particular purpose. The
entire risk as to the results and performance of this
program is assumed by you.
However, to the original purchaser only, the publisher
warrants the magnetic diskette on which the program is
recorded to be free from defects in materials and faulty
workmanship under normal use for a period of ninety days
from the date of purchase. If during this ninety-day period
the diskette should become defective, it may be returned to
the publisher for a replacement without charge, provided you
have previously sent in your limited warranty registration
and signed license agreement to the distributor.
Your sole and exclusive remedy in the event of a defect is
expressly limited to replacement of the diskette as provided
above. If failure of a diskette has resulted from accident
or abuse the distributor shall have no responsibility to
replace the diskette under the terms of this limited
warranty.
Any implied warranties relating to the diskette, including
any implied warranties of merchantability and fitness for a
particular purpose, are limited to a period of ninety days
from date of purchase. Distributor shall not be liable for
indirect special, or consequential damages resulting from
the use of this product. Some states do not allow the
exclusion or limitation of incidental or consequential
damages, so the above limitations might not apply to you.
This warranty gives you specific legal rights, and you may
also have other rights which vary from state to state.
Page 27
&F